home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / ForCLI / Renumber.lha / Renumber / renumber.doc < prev   
Text File  |  1996-03-24  |  4KB  |  105 lines
  1.  
  2.        _    ____             __      ____ _
  3.       / \  /    /\   /   //\/ //    /    / \
  4.      /__/ /_   /  \ /   // / //_   /_   /__/  A nice script utility
  5.     /\   /    /   //   //   //  \ /    /\
  6.    /  \ /___ /   / \__//   / \__//___ /  \  (c) 1996 Jan Krutisch
  7.  
  8.                            Version 1 Revision 0
  9.  
  10. INTRODUCTION
  11.  
  12.    There are times where you just miss a simple utility nobody ever
  13.       thought of and although one could easily write an arexx-script,
  14.       it seems to be the better solution to write in a serious language
  15.       with loads of options, to prepare it for every "could be"
  16.       situation. Renumber is such a tool. It took me merely 3 hours of
  17.       relaxed coding (only because I'm a bit foolish) and now it's there
  18.  
  19.    The thing as such is quite simple. It takes a given input(text)file
  20.       and searches for a pattern in every line. It replaces this "key"
  21.       by a running (increasing, decreasing) number. This is quite cool
  22.       for various purposes...It is easy to create a script by using the
  23.       LFORMAT switch of LIST...And it's easy to insert a static "key"
  24.       into every line (talking about using LIST). But try to insert a
  25.       running number...thou gets stuffed. Using my `count` program or a
  26.       strange combination of various CLI-Commands does not help since
  27.       all programs enclosed in `-signs are executed just once. Using
  28.       renumber, you would include a special "key" into your LFORMAT and
  29.       then running "renumber" on the whole script.
  30.  
  31.       Or thinking about numbering a special LIST output to create
  32.       filelists...or numbering sourcecode...well, just do it...
  33.  
  34. USAGE
  35.  
  36.    The template looks like this: FROM/A,TO/A,START/N/K,S=STEP/N/K,K=KEY/K
  37.  
  38.       FROM   -> The input file.  (Must be specified !)
  39.       TO     -> The output file. (Must be specified !)
  40.       START  -> The first inserted number (Default: 0)
  41.       STEP   -> The step value for increasing the numbers (Default: 1)
  42.       KEY    -> The key "Renumber" will replace by it's numbers (Def: %%)
  43.  
  44.    Examples
  45.  
  46.       Imagine a scriptfile "Ram:Test" looking like this:
  47.  
  48.          copy "abc-bass" to pc1:samp%%
  49.          copy "abc-synth" to pc1:samp%%
  50.          copy "abc-synth2" to pc1:samp%%
  51.  
  52.       Now I run >> Renumber ram:test ram:test2 << on it:
  53.  
  54.          copy "abc-bass" to pc1:samp0
  55.          copy "abc-synth" to pc1:samp1
  56.          copy "abc-synth2" to pc1:samp2
  57.  
  58.       Or I would run >> Renumber ram:test ram:test2 start 10 step 10 <<
  59.  
  60.          copy "abc-bass" to pc1:samp10
  61.          copy "abc-synth" to pc1:samp20
  62.          copy "abc-synth2" to pc1:samp30
  63.  
  64.       Or I could do >> Renumber ram:test ram:test2 start 5 key "$$"
  65.  
  66.          Of course this would change nothing, because the specified key
  67.          is not to be found in the original script.
  68.  
  69.       This should be enough. I think the usage is quite straightforward.
  70.  
  71. HISTORY
  72.  
  73.    Well. None. This is V1.0 and it runs. I fixed some serious bugs in
  74.    the beta-versions, but who cares...
  75.  
  76. FUTURE
  77.  
  78.    I want to implement a "Zero-Fill" that makes 1 looks like 01 or 001
  79.    if you want it to. I tried to implement it in this version, but E
  80.    does not work the way I wanted it to be :( Will be Version 1.1, I
  81.    swear.
  82.  
  83. LEGALS
  84.  
  85.    This is Public Domain. The shareware fee is $450. No, seriously, I
  86.    can't see any point why I should protect this thingie in any way.
  87.    Destroy it, delete it, or eat it (could be interesting...).
  88.    Well...nearly. I do claim a copyright on the original source thats
  89.    coming with this archieve. Change a single byte and it's yours.
  90.    BUT: If you want to use this piece of software in a commercial or
  91.    shareware package, I want to know it and I think a full registered
  92.    version would be the perfect price...
  93.  
  94. CONTACT
  95.  
  96.    For Bugreports, hints, choklate, money, synthesizers, drumsamples or
  97.        loveletters write to:
  98.  
  99.                   halfbyte@arda.shnet.org (Jan Krutisch)
  100.  
  101.                             (sorry, no snail.)
  102.  
  103. EOF
  104.  
  105.